List Search
AutomatR.Zendesk.Activities.ListSearch
The "List Search" activity in AutomatR is part of the Zendesk activities package, allowing users to perform searches in Zendesk and retrieve a list of records based on specified criteria. This activity facilitates the retrieval of tickets, users, groups, or organizations matching the provided search query.
Properties
| Name | Description |
|---|---|
| Input | |
| Maximum Records | The maximum number of records to return. Enter an Int32 or an Int32 variable. The Search API returns up to 1,000 results per query. |
| Query | The search query. Provide any string or String variable to search. The string can be a single string, a combination of words, status, IDs such as ticket ID, date, resource type, etc. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Enter the wait time in seconds (Example: 5 seconds i.e., 5) to start the activity. |
| Sort By | Enter one of the criteria: created_at, updated_at, priority, status, or ticket_type. The default is sorting by relevance. Enter a string or a String variable. |
| Sort Order | The order in which the results should be sorted, in the format [asc |
| Output | |
| List Of Search | Returns the list of records as responses based on tickets, users, groups, or organizations, as specified by the filter_type parameter. |
How to use:
- Drag and drop the "List Search" activity onto the workflow.
- Configure the properties by specifying the search query, maximum records, and optional parameters such as sort order and sort by.
- Optionally, configure the delay.
- Execute the workflow to perform a search in Zendesk and retrieve the list of matching records.
Example:
Consider an example where the "List Search" activity is used to search for tickets with a specific status:
List Search:
Query: "status:open"
Maximum Records: 10
Sort By: "created_at"
Sort Order: "asc"
List Of Search: ticketList
In this example, the activity searches for open tickets, retrieves a maximum of 10 records, sorts the results by the creation date in ascending order, and stores the list of search results in the variable "ticketList" for further processing in the workflow.